Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: update README #5095

Merged
merged 1 commit into from
Apr 10, 2023
Merged

Conversation

sfavello
Copy link
Contributor

@sfavello sfavello commented Apr 9, 2023

Contains

Fixes #5094
Removes the depreciated lgtm badges from the README doc and includes a replacement of Code climate. Code climate offers 3 different types of badges including a tech debt, maintainability, and issues. I researched replacements for the lgtm and often Code climate was recommended as a good substitute.

Update photo

Screen Shot 2023-04-09 at 11 34 58 AM

@Cervator
Copy link
Member

Cervator commented Apr 9, 2023

Hi @sfavello and thank you for the PR! Code Climate rings a bell and seems quite reasonable. Also, at this point maintainability of 'C' with "just" 11% technical debt seems both fair and surprisingly low 😁

For a moment I thought "issues" meant total GitHub issues open, or maybe total ever excluding PRs! That reminds me of when we bump Checkstyle up a degree :-)

I'll see if any other maintainers have an opinion on CC (we've also had SonarSource floating around at times) for a little while then merge, much appreciated!

@sfavello
Copy link
Contributor Author

@Cervator thank you! And definitely, I think those numbers are awesome. I was checking out CC's website and its got a lot of good feedback and tools to help analyze your repo. It was compared a bit to LGTM so i thought it might be a nice sub. When researching I saw a lot of mentions of SonarSource. It's no worries too if CC is not a good fit. I can always update the PR. I want to make sure it's something yall like in the README. 😄

@jdrueckert
Copy link
Member

Hello and welcome @sfavello ! Thanks a lot for the PR and not only throwing out the old stuff but even thinking about a useful replacement 💚

I do not have experience with Code Climate so far but I read that it might even use sonar stuff under the hood? We can definitely use it for the badges and give it a try in push validation. Main evaluation points IMO are how well it finds issues - we could try to provoke some stuff it should find to actually be useful and see if it does - and how much it helps PR authors to fix them - testing usability basically.
We do have Sonarcloud set up for the new website repo and it did help with some valid issues while it admittedly also was annoying in some of the refactoring steps involved in getting the old modulesite to become our new website. Anyway, I'll create a new issue to track a Code Climate pushval test and approve this 🙂

Thanks again @sfavello and I hope we see more of you! - here on GitHub and maybe even on our Discord 😊

@jdrueckert jdrueckert merged commit 8943264 into MovingBlocks:develop Apr 10, 2023
@jdrueckert
Copy link
Member

Oh and congrats to your first merged Terasology PR @sfavello 🎉 👏

@sfavello
Copy link
Contributor Author

Thank you so much! No worries, I love researching and had a lot of fun looking at possible replacements. Yes! I thought that was awesome, in a couple of Code Climate's repos they use SonarLint. 100%, I will definitely be helping out in any way that I can. 💛 Thank you again. 😃

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove outdated references to LGTM and optionally suggest alternatives
3 participants